home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 018a / macade41.zip / TILDECHK.DOC < prev    next >
Text File  |  1991-08-15  |  5KB  |  116 lines
  1.                   TildeChk.exe
  2.              A Utility for Checking Whether
  3.             There Are Any Missing Tildes (~)
  4.                in a WordPerfect 5.1 Macro
  5.  
  6.                       by
  7.  
  8.                  Jeffrey S. Kane, Ph.D.
  9.                Performance Sciences International
  10.                  Summerfield, NC
  11.  
  12. 1.   Read the REGISTER.doc, LICENSE.doc, and WARRANTY.doc files distributed
  13.      with this macro.
  14.  
  15. 2.   Requires:
  16.      
  17.      A.   WordPerfect 5.1 (for use of compiled macros)
  18.  
  19.      B.   MS/PC-DOS 3.0 or higher
  20.  
  21.      C.   An ASCII source file that conforms to the format of files produced
  22.       by the MacroLst decompiler also included in the MacroAde package.
  23.  
  24. 3.   Features:
  25.  
  26.      A.   Fast
  27.  
  28.      B.   Compact .exe file size
  29.  
  30.      C.   Accurate
  31.  
  32.      D.   Useful: Missing tildes are the MOST COMMON errors made in
  33.           creating macros.  This is just as true for experts as
  34.           for novices.    "Did you check your tildes?" is usually
  35.           the first question that the people at WordPerfect's Tech
  36.           Support for macros ask you when you call.  Up to now
  37.           there was no means of checking other than manually, which
  38.           often fails to discover the absent tilde.  TildeChk will
  39.           save you hours of time, even when it only confirms that
  40.           you have no missing tildes and that your bug must be in
  41.           logic or other syntax.
  42.  
  43. 4.   Installation:
  44.  
  45.      No installation is required other than to copy the
  46.      TildeChk.exe file to your WordPerfect directory.  If you
  47.      have located your other MacroAde utilities in some specific
  48.      subdirectory, it is recommended that you also locate TildeChk
  49.      there for the sake of convenience.
  50.  
  51. 5.   Operation:
  52.  
  53.      A.   TildeChk operates directly on .lst source code files
  54.       produced by MacroAde's MacroLst program, or on any source
  55.       file created in accordance with the format used by MacroLst
  56.       (see the documentation for MCompile for the specifics of
  57.       this format.)  The critical part of this format from
  58.       TildeChk's standpoint is the STARTMACRO code delimiter, which
  59.       it uses to calibrate its line number count.
  60.  
  61.      C.   Once an appropriate macro source file is ready for checking,
  62.       the TildeChk program is invoked by the following command:
  63.  
  64.               TildeChk macro(.lst)
  65.  
  66.       Note that the name of the source file on the TildeChk
  67.           command line may exclude the .lst extension, but will
  68.           accept the name with this extension if it is given. 
  69.           MCompile assumes that any source file has the .lst
  70.           extension, but this assumption may be overridden by
  71.           explicitly specifying a different extension.
  72.  
  73.      D.   TildeChk will not change your source file in any way.
  74.  
  75.      E.   TildeChk will either report that no missing tildes were
  76.       found, or it will list the line number and starting macro
  77.       command of each command sequence in which a tilde was
  78.       found to be missing.    In the case of multi-line commands
  79.       (i.e., {CASE} and {CASE CALL}) the error report will indicate
  80.       that a tilde is missing somewhere in the sequence for that
  81.       command, but won't necessarily indicate the exact line in
  82.       which the omission occurred.
  83.  
  84.      F.   In some cases one or more missing tildes in nested macro
  85.       commands may make it appear that commands at the deepest
  86.       levels of the nest have had their tilde requirements met
  87.       and the error will be reported for some command above them
  88.       in the nest.    This is unavoidable (as far as I've been able
  89.       to determine) and is not really a problem because the user
  90.       will be correctly alerted to a missing tilde in the SEQUENCE
  91.       that starts with command that is reported.
  92.  
  93.      G.   TildeChk reports a maximum of 20 missing tilde errors per run.
  94.       If this limit is reached the error listing will be preceded by
  95.       a message indicating that the maximum has been reached and the
  96.       errors found should be corrected before running TildeChk again.
  97.  
  98.      H.   TildeChk's messages and error listings are written to the screen
  99.       using the PC video BIOS.  This permits the screen output to be
  100.       be captured and repeatedly re-viewed by any of the "scrollback"
  101.       programs to assist the user in the debugging process.
  102.  
  103.  
  104. 6.   Technical support:
  105.  
  106.      Free technical support will be furnished to any licensed user
  107.      who calls on weekdays during the hours from 9:00 a.m. to 5:00 p.m.
  108.      (Eastern) at the following number:  (919) 643-3492
  109.  
  110.      We may also be reached by mail at:
  111.  
  112.      Performance Sciences International
  113.      Suite 1250
  114.      3001 Latta Drive
  115.      Summerfield, NC  27358
  116.